/* libwatopt++ - Optimization Toolkit
 *
 * Copyright (c) 2007 Christopher Alexander Watford
 * <christopher.watford@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 *
 * $Id: sa_schedules.hpp 2 2007-05-06 18:01:15Z christopher.watford $
 */

#if _MSC_VER > 1000
#pragma once
#endif /* _MSC_VER > 1000 */

#ifndef _SA_SCHEDULES_HPP_
#define _SA_SCHEDULES_HPP_

#include <opt.hpp>
#include <sa.hpp>

namespace watopt
{

   class ExponentialSteppedCooling : public IAnnealingSchedule
   {
   public:
	   ExponentialSteppedCooling(double alpha, size_t interval);

	   ExponentialSteppedCooling(const ExponentialSteppedCooling& sched);
	   virtual ~ExponentialSteppedCooling(void) { }
	   ExponentialSteppedCooling& operator=(const ExponentialSteppedCooling& sched);

	   double Step(size_t step, double temp, size_t maxStep, double maxTemp) const;

   private:
	   double _m_Alpha;
	   size_t _m_Interval;
   };

   class LinearSteppedCooling : public IAnnealingSchedule
   {
   public:
	   LinearSteppedCooling(double alpha, size_t interval);

	   LinearSteppedCooling(const LinearSteppedCooling& sched);
	   virtual ~LinearSteppedCooling(void) { }
	   LinearSteppedCooling& operator=(const LinearSteppedCooling& sched);

	   double Step(size_t step, double temp, size_t maxStep, double maxTemp) const;

   private:
	   double _m_Alpha;
      size_t _m_Interval;
   };

   class LinearCooling : public IAnnealingSchedule
   {
   public:
	   LinearCooling(double alpha);

	   LinearCooling(const LinearCooling& sched);
	   virtual ~LinearCooling(void) { }
	   LinearCooling& operator=(const LinearCooling& sched);

	   double Step(size_t step, double temp, size_t maxStep, double maxTemp) const;

   private:
	   double _m_Alpha;
   };

   class ExponentialCooling : public IAnnealingSchedule
   {
   public:
	   ExponentialCooling(double alpha);

	   ExponentialCooling(const ExponentialCooling& sched);
	   virtual ~ExponentialCooling(void) { }
	   ExponentialCooling& operator=(const ExponentialCooling& sched);

	   double Step(size_t step, double temp, size_t maxStep, double maxTemp) const;

   private:
	   double _m_Alpha;
   };

   class DampedOscillatorCooling : public IAnnealingSchedule
   {
   public:
	   // (2sin(4x)/(1+exp(x/12)))^2
	   DampedOscillatorCooling(double oscillations, double stretch);

	   DampedOscillatorCooling(const DampedOscillatorCooling& sched);
	   virtual ~DampedOscillatorCooling(void) { }
	   DampedOscillatorCooling& operator=(const DampedOscillatorCooling& sched);

	   double Step(size_t step, double temp, size_t maxStep, double maxTemp) const;

   private:
	   double _m_Osc, _m_Stretch;
   };

}

#endif /* !defined(_SA_SCHEDULES_HPP_) */